﻿#region Copyright
// Copyright (c) 2011-2012 RaisingForce Team (Alikin Sergey)
//
// Permission is hereby granted, free of charge, to any person
// obtaining a copy of this software and associated documentation
// files (the "Software"), to deal in the Software without
// restriction, including without limitation the rights to use,
// copy, modify, merge, publish, distribute, sublicense, and/or sell
// copies of the Software, and to permit persons to whom the
// Software is furnished to do so, subject to the following
// conditions:
//
// The above copyright notice and this permission notice shall be
// included in all copies or substantial portions of the Software.
//
// THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
// EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
// OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
// NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
// HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
// WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
// FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
// OTHER DEALINGS IN THE SOFTWARE.
#endregion

using System;
using System.Diagnostics.Contracts;
using RaisingForce.Raise.Measures;

namespace RaisingForce.Raise.Hardware
{
    [ContractClass(typeof(IRobotHardwareOptionsContract))]
    public interface IRobotHardwareOptions :
        IEquatable<IRobotHardwareOptions>
    {
        /// <summary>
        /// Получает номер COM-порта, используемого для соединения с роботом NXT.
        /// </summary>
        byte ComPort { get; }

        /// <summary>
        /// Получает максимальное расстояние, на котором объект, находящийся перед роботом, может считаться препятствием.
        /// </summary>
        Distance ObstacleDistance { get; }

        /// <summary>
        /// Получает расстояние, на которое робот передвигается по прямой при зафиксированном тахометром повороте колес на 360 градусов.
        /// </summary>
        Distance WheelRunDistance { get; }

        /// <summary>
        /// Получает коэффициент изменения мощности правого колеса относительно левого при движении робота по прямой.
        /// </summary>
        float WheelBalance { get; }

        /// <summary>
        /// Получает количество градусов, на которое должно повернуться правое колесо робота для совершения полного оборота в левую сторону.
        /// </summary>
        ushort LeftTurnTacho { get; }

        /// <summary>
        /// Получает количество градусов, на которое должно повернуться левое колесо робота для совершения полного оборота в правую сторону.
        /// </summary>
        ushort RightTurnTacho { get; }

        /// <summary>
        /// Получает предполагаемую мощность двигателя робота в процентах, задействующуюся при совершении движений и поворотов.
        /// </summary>
        sbyte SupposedPower { get; }

        /// <summary>
        /// Время, которое ожидает эмулятор для определения наличия или отсутствия препятствия перед роботом.
        /// </summary>
        Time ObstacleDetectionTime { get; }

        /// <summary>
        /// Время, которое ожидает эмулятор для перемещения робота по прямой при зафиксированном тахометром повороте колес на 360 градусов.
        /// </summary>
        Time WheelRunTime { get; }

        /// <summary>
        /// Время, которое ожидает эмулятор для совершения полного оборота робота в левую сторону.
        /// </summary>
        Time LeftTurnTime { get; }

        /// <summary>
        /// Время, которое ожидает эмулятор для совершения полного оборота робота в правую сторону.
        /// </summary>
        Time RightTurnTime { get; }
    }
}
